Skip to content

Conversation

@michelle0927
Copy link
Collaborator

@michelle0927 michelle0927 commented Jul 17, 2025

Resolves #17679

Summary by CodeRabbit

  • New Features

    • Added support for fetching and filtering events by group, organization, user, or authenticated user, with dynamic property visibility and helpful alerts in event listing actions and new event scheduled sources.
    • Enhanced error handling and group support in Calendly app integration.
  • Bug Fixes

    • None.
  • Chores

    • Updated version numbers for multiple actions and sources to reflect the latest changes.
    • Incremented package version to 1.3.1.

@vercel
Copy link

vercel bot commented Jul 17, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

3 Skipped Deployments
Name Status Preview Comments Updated (UTC)
docs-v2 ⬜️ Ignored (Inspect) Visit Preview Jul 18, 2025 3:39pm
pipedream-docs ⬜️ Ignored (Inspect) Jul 18, 2025 3:39pm
pipedream-docs-redirect-do-not-edit ⬜️ Ignored (Inspect) Jul 18, 2025 3:39pm

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 17, 2025

Walkthrough

This update introduces a new "scope" property to the Calendly "List Events" action and "New Event Scheduled" source, allowing users to specify whether to fetch events for the authenticated user, organization, user, or group. Supporting code for group selection, dynamic UI property visibility, and conditional parameter handling was added. Several components and the package version were incremented.

Changes

File(s) Change Summary
components/calendly_v2/actions/create-invitee-no-show/create-invitee-no-show.mjs Version increment from 0.0.3 to 0.0.4.
components/calendly_v2/actions/create-scheduling-link/create-scheduling-link.mjs Version increment from 0.0.5 to 0.0.6.
components/calendly_v2/actions/get-event/get-event.mjs Version increment from 0.1.5 to 0.1.6.
components/calendly_v2/actions/list-event-invitees/list-event-invitees.mjs Version increment from 0.0.5 to 0.0.6.
components/calendly_v2/actions/list-user-availability-schedules/list-user-availability-schedules.mjs Version increment from 0.0.1 to 0.0.2.
components/calendly_v2/sources/invitee-canceled/invitee-canceled.mjs Version increment from 0.0.3 to 0.0.4.
components/calendly_v2/sources/invitee-created/invitee-created.mjs Version increment from 0.0.4 to 0.0.5.
components/calendly_v2/sources/routing-form-submission-created/routing-form-submission-created.mjs Version increment from 0.0.3 to 0.0.4.
components/calendly_v2/package.json Package version increment from 1.3.0 to 1.3.1.
components/calendly_v2/actions/list-events/list-events.mjs Added "scope" prop (options: authenticatedUser, organization, user, group), dynamic property visibility, group support, and refactored parameter handling.
components/calendly_v2/sources/new-event-scheduled/new-event-scheduled.mjs Added "scope" prop (options: authenticatedUser, organization, user, group), dynamic property visibility, group support, and refactored parameter handling.
components/calendly_v2/calendly_v2.app.mjs Added groupId propDefinition, group support in listEvents, listGroups method, error handling in requests, and supporting helpers for dynamic props.
components/calendly_v2/common/constants.mjs Added new constant array listEventsScopes with scope options.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Action/Source
    participant CalendlyApp
    participant CalendlyAPI

    User->>Action/Source: Select scope (authenticatedUser/org/user/group)
    Action/Source->>CalendlyApp: listEvents({scope, organization, user, group, ...})
    CalendlyApp->>CalendlyAPI: GET /events with params based on scope
    CalendlyAPI-->>CalendlyApp: Events data
    CalendlyApp-->>Action/Source: Events data
    Action/Source-->>User: Display or emit events
Loading

Assessment against linked issues

Objective Addressed Explanation
Add a new prop for user to specify the scope (organization/user/group) for fetching events (#17679) New "scope" property added with options including organization, user, and group.
Default value for scope should be user (#17679) Default is set to "authenticatedUser" instead of "user".
Use specified scope on source creation to fetch new events (#17679) The "New Event Scheduled" source uses the scope property to conditionally fetch events.
Show permission error if user lacks permission for selected scope (#17679) Error handling added in _makeRequest with formatted error messages; explicit permission error handling not clearly detailed.

Suggested reviewers

  • lcaresia

Poem

A hop, a jump, a scope anew,
Calendly’s events now tailored for you!
Choose user, org, or even a group,
The rabbit’s code is in the loop.
With every version up we bound,
More flexible features now abound!
🐇✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

components/calendly_v2/actions/list-events/list-events.mjs

Oops! Something went wrong! :(

ESLint: 8.57.1

Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs
at Object.getPackageJSONURL (node:internal/modules/package_json_reader:255:9)
at packageResolve (node:internal/modules/esm/resolve:767:81)
at moduleResolve (node:internal/modules/esm/resolve:853:18)
at defaultResolve (node:internal/modules/esm/resolve:983:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:801:12)
at #cachedDefaultResolve (node:internal/modules/esm/loader:725:25)
at ModuleLoader.resolve (node:internal/modules/esm/loader:708:38)
at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:309:38)
at #link (node:internal/modules/esm/module_job:202:49)

components/calendly_v2/calendly_v2.app.mjs

Oops! Something went wrong! :(

ESLint: 8.57.1

Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs
at Object.getPackageJSONURL (node:internal/modules/package_json_reader:255:9)
at packageResolve (node:internal/modules/esm/resolve:767:81)
at moduleResolve (node:internal/modules/esm/resolve:853:18)
at defaultResolve (node:internal/modules/esm/resolve:983:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:801:12)
at #cachedDefaultResolve (node:internal/modules/esm/loader:725:25)
at ModuleLoader.resolve (node:internal/modules/esm/loader:708:38)
at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:309:38)
at #link (node:internal/modules/esm/module_job:202:49)

components/calendly_v2/common/constants.mjs

Oops! Something went wrong! :(

ESLint: 8.57.1

Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs
at Object.getPackageJSONURL (node:internal/modules/package_json_reader:255:9)
at packageResolve (node:internal/modules/esm/resolve:767:81)
at moduleResolve (node:internal/modules/esm/resolve:853:18)
at defaultResolve (node:internal/modules/esm/resolve:983:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:801:12)
at #cachedDefaultResolve (node:internal/modules/esm/loader:725:25)
at ModuleLoader.resolve (node:internal/modules/esm/loader:708:38)
at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:309:38)
at #link (node:internal/modules/esm/module_job:202:49)

  • 1 others
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@michelle0927 michelle0927 marked this pull request as ready for review July 17, 2025 18:46
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 06acae3 and 0d424ed.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (4)
  • components/calendly_v2/actions/list-events/list-events.mjs (3 hunks)
  • components/calendly_v2/calendly_v2.app.mjs (7 hunks)
  • components/calendly_v2/common/constants.mjs (1 hunks)
  • components/calendly_v2/sources/new-event-scheduled/new-event-scheduled.mjs (3 hunks)
✅ Files skipped from review due to trivial changes (1)
  • components/calendly_v2/common/constants.mjs
🚧 Files skipped from review as they are similar to previous changes (2)
  • components/calendly_v2/actions/list-events/list-events.mjs
  • components/calendly_v2/sources/new-event-scheduled/new-event-scheduled.mjs
🧰 Additional context used
🧠 Learnings (1)
components/calendly_v2/calendly_v2.app.mjs (3)
Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#12697
File: components/salesforce_rest_api/sources/common-webhook-methods.mjs:1-71
Timestamp: 2024-10-08T15:33:38.240Z
Learning: The `common-webhook-methods.mjs` object is designed to be extended, similar to an abstract class, and intentionally does not implement certain methods like `generateWebhookMeta` and `getEventType` to enforce implementation in subclasses.
Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#12697
File: components/salesforce_rest_api/sources/common-webhook-methods.mjs:1-71
Timestamp: 2024-07-24T02:06:47.016Z
Learning: The `common-webhook-methods.mjs` object is designed to be extended, similar to an abstract class, and intentionally does not implement certain methods like `generateWebhookMeta` and `getEventType` to enforce implementation in subclasses.
Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#16954
File: components/salesloft/salesloft.app.mjs:14-23
Timestamp: 2025-06-04T17:52:05.780Z
Learning: In the Salesloft API integration (components/salesloft/salesloft.app.mjs), the _makeRequest method returns response.data which directly contains arrays for list endpoints like listPeople, listCadences, listUsers, and listAccounts. The propDefinitions correctly call .map() directly on these responses without needing to destructure a nested data property.
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
  • GitHub Check: pnpm publish
  • GitHub Check: Lint Code Base
  • GitHub Check: Publish TypeScript components
  • GitHub Check: Verify TypeScript components
🔇 Additional comments (6)
components/calendly_v2/calendly_v2.app.mjs (6)

59-73: LGTM: Well-structured prop definition following established patterns.

The groupId prop definition correctly follows the same pattern as other entity prop definitions in the codebase, with proper async options handling and context passing.


135-137: LGTM: Consistent helper method following established patterns.

The _buildGroupUri method correctly mirrors the existing _buildUserUri pattern and maintains consistency in URI construction.


340-347: LGTM: Consistent implementation following established patterns.

The listGroups method correctly follows the same pattern as other list methods in the codebase, using _makeRequest for proper pagination handling.


111-126: LGTM: Well-designed props with helpful user guidance.

The listEventsScope and listEventsAlert props provide excellent user experience with clear explanations of scope options and their privilege requirements.


394-405: LGTM: Clean implementation of dynamic UI logic.

The listEventsAdditionalProps method correctly implements scope-based property visibility, providing a good user experience by showing only relevant fields based on the selected scope.


279-295: Clarify scope parameter precedence in listEvents

Currently, if both uuid (user) and params.group are provided, they’ll both be set—potentially conflicting or unintended. We need to confirm whether the Calendly API allows multiple scopes simultaneously or if only one filter (organization, group, or user) should be active at a time.

If exclusivity is required, consider refactoring to an if … else if … else chain:

    async listEvents(params, uuid, $) {
-     if (uuid) {
+     if (uuid) {
        params.user = this._buildUserUri(uuid);
-     }
-     if (params.group) {
+     } else if (params.group) {
        params.group = this._buildGroupUri(params.group);
-     }
-     if (!params.organization && !params.group && !params.user) {
+     } else if (!params.organization) {
        params.user = await this.defaultUser($);
     }

     const opts = {
       path: "/scheduled_events",
       params,
     };

     return this._makeRequest(opts, $);

• Confirm intended API behavior: can multiple scope parameters be used together?
• If not, enforce mutual exclusivity as shown above.

@michelle0927
Copy link
Collaborator Author

/approve

@michelle0927 michelle0927 merged commit d4763f3 into master Jul 21, 2025
11 checks passed
@michelle0927 michelle0927 deleted the issue-17679 branch July 21, 2025 14:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[FEATURE] Calendly - Improve List Events action and New Event Scheduled source

4 participants